home *** CD-ROM | disk | FTP | other *** search
/ The Arsenal Files 6 / The Arsenal Files 6 (Arsenal Computer).ISO / doorware / kawsol14.zip / KAWSOL.DOC < prev    next >
Text File  |  1996-01-01  |  20KB  |  454 lines
  1. ╔═════════════════════════════════════════════════════════════════════════════╗
  2. ║                                                                             ║
  3. ║                       CorpSoft BBS (815) 886-9388                           ║
  4. ║                         3 Nodes - USR 28.8  v.34                            ║
  5. ║                                                                             ║
  6. ║                           KINGS ARE WILD SOLITAIRE                          ║
  7. ║                                    v1.4                                     ║
  8. ║                                                                             ║
  9. ║                              MULTI-BBS Support                              ║
  10. ║           Supporting PCBoard, Wildcat!, Gap, QBBS, RBBS, Spitfire,          ║
  11. ║                UltraBBS, Telegard, TriTel, and Remote Access                ║
  12. ║                                                                             ║
  13. ║                               Copyright 1995                                ║
  14. ║                               by Robert Neal                                ║
  15. ║                             317 Hickory Avenue                              ║
  16. ║                            Romeoville, IL  60441                            ║
  17. ║                                                                             ║
  18. ╚═════════════════════════════════════════════════════════════════════════════╝
  19.  
  20.  
  21. Kings Are Wild is released as SHAREWARE. You are granted a limited license 
  22. to evaluate the program. Try it out, if you continue to use it for more than 
  23. 30 days you are required to register the program.
  24.  
  25. To register the program send $14.95 along with your name and BBS name
  26. to: Robert Neal, 317 Hickory Avenue, Romeoville, IL 60441. See the file
  27. MAILER.TXT for additonal pricing information and special discounts
  28. available. You may also register ONLINE with Visa or MasterCard by
  29. calling the support BBS at (815) 886-9388. Simply type CHARGE at the menu.
  30.  
  31. Once you register Kings Are Wild, you will be given your own unique 
  32. registration number. The BBS name supplied with payment will be the name 
  33. used to create your unique registration number.
  34.  
  35. THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS" WITHOUT
  36. WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  37. LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
  38. PARTICULAR PURPOSE.  IN NO EVENT SHALL ANYONE INVOLVED WITH THE CREATION AND
  39. PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT, SPECIAL, OR CONSEQUENTIAL
  40. DAMAGES, ARISING OUT OF ANY USE THEREOF OR BREACH OF ANY WARRANTY.
  41.  
  42.  
  43. *PROGRAM DESCRIPTION*
  44.  
  45. Kings Are Wild is a online game which uses 2 decks of cards, one which
  46. creates a point grid and a second which is used as the playing deck. The 
  47. object is to remove all 20 cards from the point grid. This is done by
  48. matching the value of the Deck Card with either 1 or 2 cards in the
  49. point grid. The result is a quick game which is fun and at times can be 
  50. aggravating!
  51.  
  52. Kings Are Wild keeps track of dual scoreboards, one ranking each player 
  53. on their overall monthly score and a second ranking the top 10 Kings Are 
  54. Wild scores for the month. Kings Are Wild will automatically reset the 
  55. scoreboard at the start of each month, requiring no sysop maintenance 
  56. after initial set-up.
  57.  
  58.  
  59. *PROGRAM FEATURES*
  60.  
  61.   -  Easy to install and requires no maintenance.
  62.   -  Ansi colors and display.
  63.   -  Terminates cleanly through exit code even on runtime error.
  64.   -  Automatically creates a top score listing suitable for inclusion
  65.      as a text/bulletin file for display within your BBS. Both an
  66.      ANSI and ASCII file is created.
  67.   -  Detects loss of carrier.
  68.   -  Operates in local mode (either direct from BBS or from command line).
  69.   -  Sysop function keys to return to the board, chat mode, user stats,
  70.      increase/decrease time, etc.
  71.   -  Direct support for PCBoard, WildCat!, Gap, QBBS, RBBS,
  72.      Ultra BBS, Telegard, TriTel and Remote Access.
  73.   -  Support for baud rates up to 115,200
  74.   -  Support for COM1-15. Optional command line for non-standard IRQ's.
  75.   -  Supports PCBoard environment variables %PCBDRIVE% and %PCBDIR%
  76.   -  Support Fossil Drivers. A Fossil driver is not required to use the
  77.      program.
  78.   -  Fully Multi-Node compatible.
  79.   -  Support for multi-port digiboards, for use with PCBoard /M.
  80.   -  Yearly scoreboard with rolling 12 month top scores
  81.   -  Optional "adopted by" banner to acknowledge users who contribute
  82.      towards registration of the game
  83.   -  Local play option to evaluate the program
  84.  
  85.  
  86. Kings Are Wild is fully functional, with no annoying nag screens, random
  87. resets, demo key, etc. However, as an encouragement to register Kings
  88. Are Wild, several configuration items are only available when registered:
  89.  
  90.     - Games are limited to 3 per day
  91.     - Make up games is disabled
  92.     - Cardbacks can not be customized
  93.  
  94.  
  95.  
  96.  
  97. *FIRST TIME OPERATIONS*
  98.  
  99. Simply create a directory for Kings Are Wild and copy all files distributed
  100. with Kings Are Wild to this directory. Additional data files will automatically
  101. be created the first time Kings Are Wild is run.
  102.  
  103.  
  104. CONFIGURING THE PROGRAM
  105. Use the program KAWCFG which is included with the distributed program to 
  106. edit the file KAWSOL.CFG. Below is the layout of this file:
  107.  
  108. C:\PCB\PCBOARD.SYS
  109. Corporate Headquarters
  110. Bob
  111. Neal
  112. 15
  113. 0
  114. 0
  115. NA
  116. 5
  117. «≈»
  118. «≈»
  119.  
  120. Line 1 = Full pathname of your door file. Formats supported by this
  121.      program are: PCBOARD.SYS, USERS.SYS, DOOR.SYS, USERINFO.DAT,
  122.               CALLINFO.BBS, DORINFOx.DEF, SFDOORS.DAT and
  123.               GTUSER.BBS, DOOR.SYS, and TRIBBS.SYS. When using
  124.               USERINFO.DAT, DOOR.SYS  must be in the same
  125.               directory as USERINFO.DAT.
  126. Line 2 = BBS name
  127. Line 3 = Sysop First Name
  128. Line 4 = Sysop Last Name
  129. Line 5 = number of rounds per day that a player may play. I suggest
  130.         a daily limit of 5 to 10, but tailor to your own needs.
  131. Line 6 = Registration number. Leave as 0 if unregistered.
  132. Line 7 = You can place the name of the user who helped pay for the
  133.         registration of the door. Several sysops have specified that
  134.         users have paid the reigstration fee for Kings Are Wild. You can
  135.         now place their name on this line and their name will be
  136.         proudly displayed at the end of the game so that others may
  137.         recognize their contribtion to the operation of your BBS.
  138.         Leave this blank or NA if you do not wish to use this
  139.         option.
  140. Line 8 = Maximum number of make up games per day. You can allow your
  141.         users to make up games lost because they were unable to 
  142.         call and play. Enter the number of GAMES (not days) you 
  143.         allow them to make up each day. 
  144. Line 9 = Many sysops prefer the option to create the own customized
  145.         cardback. Line 9 is the cardback for the upper half of
  146.         the card. Enter whatever 3 character back you want.
  147.         Leave this blank if you want to use the default cardback.
  148. Line 10= Cardback design for the lower half of the card. You can enter
  149.         the same characters as line 9 or a different 3 character
  150.         set.
  151.  
  152. Examples of what you might enter for line 9 and 10 are:
  153.     ┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐┌───┐
  154.     │KAW││C S││«≈»││▐≡▌││(((││###││░▒░││\\\││[:]│
  155.     │(_)││BBS││«≈»││▐≡▌││)))││###││░▒░││///││[:]│
  156.     └───┘└───┘└───┘└───┘└───┘└───┘└───┘└───┘└───┘
  157.  
  158.                    
  159.  
  160.  
  161. *EXECUTING PROGRAM*
  162.  
  163. To execute the program, enter the filename followed by the config file
  164. name (ie KAWSOL KAWSOL.CFG). If you are running the program from the
  165. command line, you may optionally enter KAWSOL LOCAL. The only problem
  166. with this is the default user name sysop is used instead of the name on
  167. your board. This is good for testing the game before putting it on your
  168. system, but you should once play begins, execute the program locally
  169. from your BBS or consistantly run the game from the command line when
  170. you play.
  171.  
  172. You may also specify a non-standard IRQ. Put the IRQ number after the
  173. .CFG on the command line. For example: KAWSOL KAWSOL.CFG /5. This
  174. example tells the program to use IRQ 5 instead of the standard IRQ.
  175.  
  176. You may also use the procedure above and create a variable IRQ so that
  177. you can pass the IRQ setting as: KAWSOL KAWSOL.CFG /%IRQ%
  178.  
  179. Some users may have had conflicts when using non-standard IRQ's on
  180. Novell/Netware systems. Novell seems to use the "/" character for
  181. parameter passing. You may not optionally use the "*" character instead
  182. of the "/", for example KAWSOL KAWSOL.CFG *%IRQ% is valid. Both "*" and
  183. "/" will work.
  184.  
  185.  
  186. *AUTOMATIC MAINTENANCE*
  187.  
  188. The program will automatically during the first play of each new month
  189. reset it's user file and top score listing. The previous months
  190. scoreboard will be renamed to KAWSOL.OLD and KAWSOLG.OLD. This can then 
  191. be included as a text file to display the previous months winners.
  192.  
  193. You should be aware of this so if you are starting a new game for the
  194. first time towards the end of the month, the game will automatically perform
  195. the maintenace come the first of the month.
  196.  
  197. As an option, you may pass the parameter "NEW" on the command line, for 
  198. example KAWSOL NEW. This will reset _all_ Kings Are Wild data files, including the
  199. overall high scorer information. 
  200.  
  201.  
  202.  
  203. *FOSSIL DRIVER*
  204.  
  205. Kings Are Wild includes support for FOSSIL drivers. This means that the
  206. program will work with Digiboard (for Wildcat M and PCBoard/M versions) 
  207. and other multi-port boards. To activate the Fossil driver support just 
  208. include /FD on the command line in your door batch file.
  209.  
  210.     For example: KAWSOL KAWSOL.CFG /FD
  211.  
  212. If no Fossil driver is available, Kings Are Wild will display a message
  213. indicating such and exit cleanly.
  214.  
  215.  
  216. This documentation will not go into the mechanics of how you set-up a door
  217. program on your BBS. It is assumed that you have a working knowledge of
  218. how to complete this task. It would be impossible for me to explain how
  219. to install a door for all BBS programs supported by Kings Are Wild.
  220.  
  221.  
  222. *SYSOP KEYS ACTIVE*
  223.  
  224. F3    -  Toggles the printer On/Off. Value is passed to PCBoard and/or
  225.      written to DOOR.SYS and USERS.SYS
  226. F4    -  Toggles the Page Bell on/off. Value is passed to PCBoard
  227.      and/or written to DOOR.SYS and USERS.SYS
  228. F5    -  DOS Shell. Allows SysOp to exit to DOS from inside a DOOR.
  229. F7    -  Toggles the Caller Alarm On/Off. Value is passed to PCBoard
  230.      and/or written to DOOR.SYS and USERS.SYS
  231. F8    -  Returns the caller involuntarily to the BBS.
  232. F9    -  Toggles the local display On/Off. Value is passed to PCBoard
  233.      and/or written to DOOR.SYS and USERS.SYS
  234. F10   -  Activates SysOp CHAT mode within the DOOR.
  235. ESC   -  Deactivates CHAT mode.  DOOR is resumed.
  236. UP    -  Give the caller extra time while in the DOOR.  
  237. DN    -  Subtract time from the caller while in the DOOR. 
  238. HOME  -  HELP key for Status Line options.
  239. ALT-N -  SysOp next on toggle. Value passed to PCBoard. (PCBoard only)
  240. ALT-X -  PCBoard will exit after current caller logs off. Value is
  241.      passed to PCBoard. Not available on non-PCBoard systems.
  242.  
  243.  
  244. *MAKE UP DAYS OPTION (Registered version only)*
  245.  
  246. Many users will not participate in a game if they know they will be 
  247. unable to play each and every day. With the Make Up Days option, you can
  248. allow players to make up missed games (the number allowed per day is 
  249. defined by you). If you enter a 0, you will disable this option. Please 
  250. note that the value placed on this field in the .CFG file is the
  251. number of games, not days, you will allow the user to make up. 
  252.  
  253. As an example, if you allow 5 games per day, but allow 8 make up games, 
  254. the user will be able to play a maximum of 13 games on any single day. 
  255. If the user has played all games to date then the user will only be 
  256. allowed to play 5 games (as defined by you for number of plays per day).
  257.  
  258.  
  259. *ADOPTED BY OPTION (Registered version only)*
  260.  
  261. Many sysops are fortunate to have their users offer to register a door
  262. they enjoy playing. You can now give recognition to the user or users
  263. who assist in contributing to the registration of this program. Simply 
  264. enter their name(s) on the appropriate line in the configuration file.
  265.  
  266. When unregistered, the door will inform the user that they can adopt
  267. the door and refers them to ask you for details. You can give the
  268. user the registration form for them to send in if you'd like.
  269.  
  270. After the program is registered, each time a user quits the game a
  271. screen will be displayed informing other users who contributed towards
  272. the registration of the game. 
  273.  
  274. If you wish to disable this option, enter NA on the line in the 
  275. configuration file.
  276.  
  277.  
  278.  
  279. *FILES USED AND CREATED*
  280.  
  281. KAWSOL.EXE  - The program itself
  282. KAWSOL.DOC  - Documentation for the sysop to run Kings Are Wild
  283. KAWSOL.CFG  - Configuration file
  284. KAWOPEN.ANS - Opening introduction screen
  285. KAWSOL.HLP  - Help information display
  286.  
  287. The following files will be created by Kings Are Wild
  288.  
  289. KAWSOL.USR  - User file of current players
  290. KAWOPEN.ANS - Opening Screen
  291. KAWSOL.ASC  - Top 10 scores in ascii format can be used as a bulletin
  292. KAWSOL.ANS  - Top 10 scores in ANSI format
  293. KAWSOL.OLD  - Previous month top 10 ascii bulletin
  294. KAWSOLG.OLD - Previous month top 10 ANSI bulletin
  295. KAWSOL.DAT  - Contains information for scoreboard
  296. KAWSOL.HI   - Contains overall high score information
  297. KAWSOL.SCO  - Data file for scoreboard
  298. KAWSOL.TOT  - Data file for scoreboard
  299. KAWSOL.MSB  - Yearly scoreboard
  300. KAWSOL.MG   - Data file for yearly scoreboard
  301. KAWSOL.MP   - Data file for yearly scoreboard
  302.  
  303.  
  304. *TROUBLESHOOTING*
  305.  
  306. -  If you are running this Door on a 486 system and encounter an error
  307.    message "ERROR 6 - OVERFLOW ERROR" or you experience irratic Keyboard
  308.    Timeout messages, you may have to put the following in either your
  309.    AUTOEXEC.BAT file or in the batch file you use to call this program.
  310.  
  311.      SET NO87=ON
  312.  
  313.    If you are running on a 486 system with co-processor under DesqView, you
  314.    may alternately set Math Coprocessor in each window to YES.
  315.  
  316. -  If you encounter an ERROR 62 when the program first is loaded, this
  317.    will usually indicate that there is an error in your .CFG file. 
  318.    Recheck your .CFG file to verify the proper format (if you use the
  319.    KAWCFG program you should never encounter this error).
  320.  
  321. -  An ERROR 70 message means you more than likely do not have SHARE
  322.    loaded. This is typically only required for multi-node systems.
  323.  
  324.  
  325. *MULTI-NODE OPERATION*
  326.  
  327. If you are running a multi-node BBS, there are two ways which you      
  328. can set-up Kings are Wild.
  329.     
  330.     1. Create a seperate configuration file for each node.
  331.        The only difference between the configuration files would
  332.        be the location of your BBS drop file. 
  333.     
  334.     2. You can use one configuration file for all nodes by 
  335.        using an environment variable. Both PCBoard and Wildcat
  336.        provide these automatically when running a door program.
  337.        For PCBoard, the environment variables are PCBDIR and PCBDRIVE.
  338.        You can then place the following on the first line of your
  339.        configuration file:
  340.         %PCBDRIVE%%PCBDIR%\PCBOARD.SYS
  341.        For Wildcat systems, it uses the variable WCNODEID, you can 
  342.        place the following on the first line of your configuration
  343.        file: 
  344.         C:\WC30\WCWORK\NODE%WCNODEID%\DOOR.SYS
  345.  
  346.        If you are running other BBS software, you should be able to
  347.        create these variables so that you can run the program as
  348.        explained above.
  349.  
  350.        Other BBS systems may also use these variables by
  351.        including the following either in your BBS batch or 
  352.        AUTOEXEC.BAT file:
  353.  
  354.         SET PCBDRIVE=C:            <- Drive letter of your BBS files
  355.         SET PCBDIR=\BBS            <- Path of your BBS files
  356.  
  357.  
  358.  
  359.  
  360. *CONTACT ME FOR SUPPORT*
  361.  
  362. If you encounter any problems you may contact me at Corporate Headquarters
  363. BBS (815) 886-9388.
  364.  
  365. I can also be reached via the RIME network in the SYSOP, DOORS,
  366. SHAREWARE and BBS SOFTWARE conferences as well as the COMMON conference.
  367. I can also be reached via Internet e-mail at bob.neal@corpsoft.com. or
  368. via FIDO at 1:2235/886 (Bob Neal@1:2235/886).
  369.  
  370. If you have any suggestions for improvements for this program, please feel
  371. free to let me know. This game has included suggestions from users of my
  372. BBS during beta testing.
  373.  
  374.  
  375. *DISTRIBUTION SITES*
  376.  
  377.    As always you can find the latest version of Kings Are Wild available for
  378.    downloading from CorpSoft BBS.
  379.  
  380.    CorpSoft BBS   (815) 886-9388 (3 nodes with automatic ring-down,
  381.                   running USR 28800 v.everything)
  382.  
  383.    Also, I have a support conference on Salt Air BBS (home of PCBoard).
  384.    Join conference #71 (CorpSoft Support). I will always have the 
  385.    current version available for download on there as well as answer 
  386.    technical support question.
  387.  
  388. We also accept Visa and Mastercard. Register online with your Visa or
  389. Mastercard by calling CorpSoft BBS, simply type CHARGE at the main menu
  390. prompt.
  391.  
  392. User's with FIDO capabilities can FREQ the latest version of my software 
  393. from me at 1:2235/886. The magic names for my software are:
  394.     KING            Kings Are Wild
  395.     CARD            Card Sharks
  396.     BOWL            BBS Bowling Solitaire
  397.     GOLF            Links Golf
  398.     ZWORD           Z-Wordz
  399.     WOTW            War of the Words
  400.     CORPSOFT        All my shareware releases
  401.  
  402. Those with FTP capabilities can FTP my software from:
  403.     europa.com      cd /outoing/DOORS/corpsoft
  404.  
  405.  
  406. To further make it convenient for people to download my software, you can
  407. also login to my support BBS by enter CORPSOFT GUEST when prompted for 
  408. your name. You will not need to go through the new user information
  409. questionaire and will immediately be able to download my shareware. 
  410. Please note that if you wish to register online, you will need to
  411. set-up a user account so that your registration keys can be made available
  412. to you.
  413.  
  414.  
  415.  
  416. *VERSION HISTORY*
  417.  
  418. v1.4 - With the new year I found that the yearly scoreboards displayed
  419.     an incorrect date for the December rollover information, the
  420.     date was shown as 12/96 instead of 12/95. Fixed. Also, the
  421.     incorrect yearly scoreboard information will be corrected the
  422.     first time that the "Y"early scoreboard is displayed within the
  423.     game.
  424.  
  425. v1.3 - Put in UNDO command so that a user can undo his first card played
  426.     (this was always possible by entering an invalid play card, but
  427.     was not always known or understood).
  428.      - Found that if only one ACE was in the playing grid, and it was
  429.     the 20th card, and if an ACE was the first card to be played the
  430.     game thought you had no moves and ended the game. Program now
  431.     sees that you have an ACE to be played.
  432.      - Made the cardback (design shown when cards are played) a sysop
  433.     configurable option.
  434.      - KAW now flashes the column bonus score to show it's been awarded
  435.     to the player.
  436.      - Fixed a minor display problem with the number of games left. The
  437.     display always showed that you had 1 more play left than you
  438.     actually did.
  439.      - Recompiled using new version of I/O library.       
  440.  
  441. v1.2 -  Fixed a problem with the monthly rollover routine.
  442.  
  443. v1.1 -  Added routine to check if the current deck card can be played
  444.     in the point card grid. If not, the game will automatically 
  445.     end.
  446.      -  Fixed problem with number of make up games always being set
  447.     to 3
  448.      -  Fixed problem with the scores in the yearly scoreboard being
  449.     displayed in reverse of actual order
  450.  
  451. v1.0 - Initial Release
  452.  
  453.  
  454.